Repository navigation
docs: unify README presentation - #174
Merged
Merged
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #172
Resulting behavior
The root README and the core, viewer, cli, sdk and VS Code extension READMEs now use the shared Vite-style layout: badge block, tagline, 4-6 feature bullets, intro, docs link, existing body, and the common footer. Badges and links were curled; npm.com returns 403/429 to curl so those packages were confirmed with
npm view.Validation
check-readme.mjspasses on every changed READMEoxfmtapplied to changed filespnpm build,pnpm tsc,pnpm lint,pnpm testpass, pluspnpm docs:buildandpnpm packagein packages/vscode-extension (vsce accepted the README)